Package | ca.on.ehr.r4 |
Type | CapabilityStatement |
Id | Id |
FHIR Version | R4 |
Source | https://simplifier.net/resolve?scope=ca.on.ehr.r4@1.0.0-snapshot4&canonical=https://ontariohealth.ca/fhir/ehr/CapabilityStatement/ehr-consumer |
Url | https://ontariohealth.ca/fhir/ehr/CapabilityStatement/ehr-consumer |
Version | 1.0.0 |
Status | active |
Date | 2025-03-16 |
Name | EhrConsumerIGCapabilityStatement |
Title | EHR Consumer IG Capability Statement |
Experimental | False |
Realm | uv |
Authority | national |
Description | This CapabilityStatement defines the search capabilities of the EHR Consumer IG. It provides access to various EHR profiles using the search operation. |
Purpose | Defines the supported search interaction for consumer applications accessing EHR data via FHIR. |
Copyright | Copyright © Ontario Health |
Kind | capability |
No resources found
No resources found
{
"resourceType" : "CapabilityStatement",
"id" : "ehr-consumer-ig-capabilitystatement",
"url" : "https://ontariohealth.ca/fhir/ehr/CapabilityStatement/ehr-consumer",
"version" : "1.0.0",
"name" : "EhrConsumerIGCapabilityStatement",
"title" : "EHR Consumer IG Capability Statement",
"status" : "active",
"experimental" : false,
"date" : "2025-03-16",
"publisher" : "Ontario Health",
"contact" : [
{
"name" : "Ontario Health",
"telecom" : [
{
"system" : "email",
"value" : "DigitalHealthStandards@ontariohealth.ca"
}
]
}
],
"description" : "This CapabilityStatement defines the search capabilities of the EHR Consumer IG. It provides access to various EHR profiles using the search operation.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "CA",
"display" : "Canada"
}
]
}
],
"purpose" : "Defines the supported search interaction for consumer applications accessing EHR data via FHIR.",
"copyright" : "Copyright © Ontario Health",
"kind" : "capability",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "server",
"documentation" : "This CapabilityStatement defines the search capabilities of the EHR Consumer IG. It provides access to various EHR profiles using the search operation.",
"security" : {
"cors" : true,
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "SMART-on-FHIR",
"display" : "OAuth2 using SMART-on-FHIR"
}
],
"text" : "This API supports OAuth2 authentication using SMART-on-FHIR."
}
]
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Patient",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Patient",
"documentation" : "Supports searching Patient resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "Search by patient identifier (e.g. MRN, HCN)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"type" : "string",
"documentation" : "Search by patient name."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "birthdate",
"type" : "date",
"documentation" : "Search by date of birth."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Encounter",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Encounter",
"documentation" : "Supports searching Encounter resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "Search by encounter identifier."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Search encounters by patient reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"type" : "token",
"documentation" : "Search by encounter status (e.g. in-progress, finished)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Practitioner",
"documentation" : "Supports searching Practitioner resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "Search by practitioner identifier."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"type" : "string",
"documentation" : "Search by practitioner name."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "PractitionerRole",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-PractitionerRole",
"documentation" : "Supports searching PractitionerRole resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "practitioner",
"type" : "reference",
"documentation" : "Search by practitioner reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "organization",
"type" : "reference",
"documentation" : "Search by organization reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "role",
"type" : "token",
"documentation" : "Search by role code for the PractitionerRole resource."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "ServiceRequest",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-ServiceRequest",
"documentation" : "Supports searching ServiceRequest resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Search by patient reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "encounter",
"type" : "reference",
"documentation" : "Search by encounter reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"type" : "token",
"documentation" : "Search by request status (e.g. active, completed)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "AllergyIntolerance",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-AllergyIntolerance",
"documentation" : "Supports searching AllergyIntolerance resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Search by patient reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"type" : "token",
"documentation" : "Search by clinical status (e.g. active, inactive)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"type" : "token",
"documentation" : "Search by allergy intolerance code."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "MedicationRequest",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-MedicationRequest",
"documentation" : "Supports searching MedicationRequest resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Search by patient reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"type" : "token",
"documentation" : "Search by request status (e.g. active, completed)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "intent",
"type" : "token",
"documentation" : "Search by request intent (e.g. order)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Condition",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Condition",
"documentation" : "Supports searching Condition resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "patient",
"type" : "reference",
"documentation" : "Search by patient reference."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"type" : "token",
"documentation" : "Search by condition clinical status (e.g. active, inactive)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"type" : "token",
"documentation" : "Search by condition category (e.g. problem-list-item)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"type" : "token",
"documentation" : "Search by condition code."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Organization",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Organization",
"documentation" : "Supports searching Organization resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "Search by organization identifier."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"type" : "string",
"documentation" : "Search by organization name."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "type",
"type" : "token",
"documentation" : "Search by organization type (e.g. hospital, clinic)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Location",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Location",
"documentation" : "Supports searching Location resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "Search by location identifier."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"type" : "string",
"documentation" : "Search by location name."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"type" : "token",
"documentation" : "Search by location status (active, inactive)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Medication",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Medication",
"documentation" : "Supports searching Medication resources.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"type" : "token",
"documentation" : "Search by medication code (e.g. RxNorm, DIN)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"type" : "token",
"documentation" : "Search by medication status (e.g. active, entered-in-error)."
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "OperationOutcome",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-OperationOutcome",
"documentation" : "Supports returning OperationOutcome resources (e.g., for errors).",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Bundle",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-searchset",
"documentation" : "Supports retrieving searchset bundles.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Bundle",
"profile" : "http://ontariohealth.ca/fhir/ehr/StructureDefinition/profile-Bundle-document",
"documentation" : "Supports retrieving document bundles.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
}
]
}
]
}
],
"text" : {
}
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.